Autogenerated HTML docs for v1.8.1-rc2-5-g252f9
diff --git a/git-config.html b/git-config.html index f303e6c..b75c5f2 100644 --- a/git-config.html +++ b/git-config.html
@@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.5.2" /> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> +<meta name="generator" content="AsciiDoc 8.6.8" /> <title>git-config(1)</title> <style type="text/css"> -/* Debug borders */ -p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { -/* - border: 1px solid red; -*/ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; } body { @@ -35,13 +45,8 @@ color: #083194; } -tt { - color: navy; -} - h1, h2, h3, h4, h5, h6 { color: #527bbd; - font-family: sans-serif; margin-top: 1.2em; margin-bottom: 0.5em; line-height: 1.3; @@ -59,9 +64,11 @@ h3 + * { clear: left; } +h5 { + font-size: 1.0em; +} div.sectionbody { - font-family: serif; margin-left: 0; } @@ -77,45 +84,48 @@ ul, ol, li > p { margin-top: 0; } +ul > li { color: #aaa; } +ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } -span#author { + +#author { color: #527bbd; - font-family: sans-serif; font-weight: bold; font-size: 1.1em; } -span#email { +#email { } -span#revnumber, span#revdate, span#revremark { - font-family: sans-serif; +#revnumber, #revdate, #revremark { } -div#footer { - font-family: sans-serif; +#footer { font-size: small; border-top: 2px solid silver; padding-top: 0.5em; margin-top: 4.0em; } -div#footer-text { +#footer-text { float: left; padding-bottom: 0.5em; } -div#footer-badges { +#footer-badges { float: right; padding-bottom: 0.5em; } -div#preamble { +#preamble { margin-top: 1.5em; margin-bottom: 1.5em; } -div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { margin-top: 1.0em; @@ -135,7 +145,6 @@ /* Block element titles. */ div.title, caption.title { color: #527bbd; - font-family: sans-serif; font-weight: bold; text-align: left; margin-top: 1.0em; @@ -157,13 +166,15 @@ div.sidebarblock > div.content { background: #ffffee; - border: 1px solid silver; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; padding: 0.5em; } div.listingblock > div.content { - border: 1px solid silver; - background: #f4f4f4; + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; padding: 0.5em; } @@ -171,8 +182,8 @@ padding-left: 1.0em; margin-left: 1.0em; margin-right: 10%; - border-left: 5px solid #dddddd; - color: #777777; + border-left: 5px solid #f0f0f0; + color: #888; } div.quoteblock > div.attribution { @@ -180,8 +191,9 @@ text-align: right; } -div.verseblock > div.content { - white-space: pre; +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; } div.verseblock > div.attribution { padding-top: 0.75em; @@ -254,35 +266,12 @@ margin-bottom: 0.1em; } -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-family: sans-serif; - font-weight: bold; -} tfoot { font-weight: bold; } td > div.verse { white-space: pre; } -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - div.hdlist { margin-top: 0.8em; @@ -339,25 +328,32 @@ min-width: 100px; } - -@media print { - div#footer-badges { display: none; } +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; } -div#toc { +@media print { + #footer-badges { display: none; } +} + +#toc { margin-bottom: 2.5em; } -div#toctitle { +#toctitle { color: #527bbd; - font-family: sans-serif; font-size: 1.1em; font-weight: bold; margin-top: 1.0em; margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -373,69 +369,173 @@ margin-left: 6em; font-size: 0.9em; } -/* Overrides for manpage documents */ -h1 { + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } + +div.unbreakable { page-break-inside: avoid; } + + +/* + * xhtml11 specific + * + * */ + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { padding-top: 0.5em; padding-bottom: 0.5em; border-top: 2px solid silver; border-bottom: 2px solid silver; } -h2 { +body.manpage h2 { border-style: none; } -div.sectionbody { - margin-left: 5%; +body.manpage div.sectionbody { + margin-left: 3em; } @media print { - div#toc { display: none; } + body.manpage div#toc { display: none; } } -/* Workarounds for IE6's broken and incomplete CSS2. */ -div.sidebar-content { - background: #ffffee; - border: 1px solid silver; - padding: 0.5em; -} -div.sidebar-title, div.image-title { - color: #527bbd; - font-family: sans-serif; - font-weight: bold; - margin-top: 0.0em; - margin-bottom: 0.5em; -} - -div.listingblock div.content { - border: 1px solid silver; - background: #f4f4f4; - padding: 0.5em; -} - -div.quoteblock-attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock-content { - white-space: pre; -} -div.verseblock-attribution { - padding-top: 0.75em; - text-align: left; -} - -div.exampleblock-content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -/* IE6 sets dynamically generated links as visited. */ -div#toc a:visited { color: blue; } </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -497,6 +597,25 @@ } var toc = document.getElementById("toc"); + if (!toc) { + return; + } + + // Delete existing TOC entries in case we're reloading the TOC. + var tocEntriesToRemove = []; + var i; + for (i = 0; i < toc.childNodes.length; i++) { + var entry = toc.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' + && entry.getAttribute("class") + && entry.getAttribute("class").match(/^toclevel/)) + tocEntriesToRemove.push(entry); + } + for (i = 0; i < tocEntriesToRemove.length; i++) { + toc.removeChild(tocEntriesToRemove[i]); + } + + // Rebuild TOC entries. var entries = tocEntries(document.getElementById("content"), toclevels); for (var i = 0; i < entries.length; ++i) { var entry = entries[i]; @@ -524,24 +643,44 @@ */ footnotes: function () { - var cont = document.getElementById("content"); + // Delete existing footnote entries in case we're reloading the footnodes. + var i; var noteholder = document.getElementById("footnotes"); + if (!noteholder) { + return; + } + var entriesToRemove = []; + for (i = 0; i < noteholder.childNodes.length; i++) { + var entry = noteholder.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") + entriesToRemove.push(entry); + } + for (i = 0; i < entriesToRemove.length; i++) { + noteholder.removeChild(entriesToRemove[i]); + } + + // Rebuild footnote entries. + var cont = document.getElementById("content"); var spans = cont.getElementsByTagName("span"); var refs = {}; var n = 0; for (i=0; i<spans.length; i++) { if (spans[i].className == "footnote") { n++; - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + var note = spans[i].getAttribute("data-note"); + if (!note) { + // Use [\s\S] in place of . so multi-line matches work. + // Because JavaScript has no s (dotall) regex flag. + note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + spans[i].innerHTML = + "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + + "' title='View footnote' class='footnote'>" + n + "</a>]"; + spans[i].setAttribute("data-note", note); + } noteholder.innerHTML += "<div class='footnote' id='_footnote_" + n + "'>" + "<a href='#_footnoteref_" + n + "' title='Return to text'>" + n + "</a>. " + note + "</div>"; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; var id =spans[i].getAttribute("id"); if (id != null) refs["#"+id] = n; } @@ -561,13 +700,36 @@ } } } +}, + +install: function(toclevels) { + var timerId; + + function reinstall() { + asciidoc.footnotes(); + if (toclevels) { + asciidoc.toc(toclevels); + } + } + + function reinstallAndRemoveTimer() { + clearInterval(timerId); + reinstall(); + } + + timerId = setInterval(reinstall, 500); + if (document.addEventListener) + document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); + else + window.onload = reinstallAndRemoveTimer; } } +asciidoc.install(); /*]]>*/ </script> </head> -<body> +<body class="manpage"> <div id="header"> <h1> git-config(1) Manual Page @@ -580,10 +742,11 @@ </div> </div> <div id="content"> +<div class="sect1"> <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="verseblock-content"><em>git config</em> [<file-option>] [type] [-z|--null] name [value [value_regex]] +<pre class="content"><em>git config</em> [<file-option>] [type] [-z|--null] name [value [value_regex]] <em>git config</em> [<file-option>] [type] --add name value <em>git config</em> [<file-option>] [type] --replace-all name value [value_regex] <em>git config</em> [<file-option>] [type] [-z|--null] --get name [value_regex] @@ -596,10 +759,12 @@ <em>git config</em> [<file-option>] [-z|--null] -l | --list <em>git config</em> [<file-option>] --get-color name [default] <em>git config</em> [<file-option>] --get-colorbool name [stdout-is-tty] -<em>git config</em> [<file-option>] -e | --edit</div> -<div class="verseblock-attribution"> +<em>git config</em> [<file-option>] -e | --edit</pre> +<div class="attribution"> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"><p>You can query/set/replace/unset options with this command. The name is @@ -607,7 +772,7 @@ escaped.</p></div> <div class="paragraph"><p>Multiple lines can be added to an option by using the <em>--add</em> option. If you want to update or unset an option which can occur on multiple -lines, a POSIX regexp <tt>value_regex</tt> needs to be given. Only the +lines, a POSIX regexp <code>value_regex</code> needs to be given. Only the existing values that match the regexp are updated or unset. If you want to handle the lines that do <strong>not</strong> match the regex, just prepend a single exclamation mark in front (see also <a href="#EXAMPLES">[EXAMPLES]</a>).</p></div> @@ -666,6 +831,8 @@ </ol></div> <div class="paragraph"><p>On success, the command returns the exit code 0.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_options">OPTIONS</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -685,7 +852,7 @@ <p> Adds a new line to the option without altering any existing values. This is the same as providing <em>^$</em> as the value_regex - in <tt>--replace-all</tt>. + in <code>--replace-all</code>. </p> </dd> <dt class="hdlist1"> @@ -859,14 +1026,14 @@ </dt> <dd> <p> - Find the color setting for <tt>name</tt> (e.g. <tt>color.diff</tt>) and output - "true" or "false". <tt>stdout-is-tty</tt> should be either "true" or + Find the color setting for <code>name</code> (e.g. <code>color.diff</code>) and output + "true" or "false". <code>stdout-is-tty</code> should be either "true" or "false", and is taken into account when configuration says - "auto". If <tt>stdout-is-tty</tt> is missing, then checks the standard + "auto". If <code>stdout-is-tty</code> is missing, then checks the standard output of the command itself, and exits with status 0 if color is to be used, or exits with status 1 otherwise. - When the color setting for <tt>name</tt> is undefined, the command uses - <tt>color.ui</tt> as fallback. + When the color setting for <code>name</code> is undefined, the command uses + <code>color.ui</code> as fallback. </p> </dd> <dt class="hdlist1"> @@ -874,10 +1041,10 @@ </dt> <dd> <p> - Find the color configured for <tt>name</tt> (e.g. <tt>color.diff.new</tt>) and + Find the color configured for <code>name</code> (e.g. <code>color.diff.new</code>) and output it as the ANSI color escape sequence to the standard - output. The optional <tt>default</tt> parameter is used instead, if - there is no color configured for <tt>name</tt>. + output. The optional <code>default</code> parameter is used instead, if + there is no color configured for <code>name</code>. </p> </dd> <dt class="hdlist1"> @@ -900,12 +1067,14 @@ </dt> <dd> <p> - Respect <tt>include.*</tt> directives in config files when looking up + Respect <code>include.*</code> directives in config files when looking up values. Defaults to on. </p> </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="FILES">FILES</h2> <div class="sectionbody"> <div class="paragraph"><p>If not set explicitly with <em>--file</em>, there are four files where @@ -963,6 +1132,8 @@ to the global or system-wide file respectively. The GIT_CONFIG environment variable has a similar effect, but you can specify any filename you want.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_environment">ENVIRONMENT</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -979,133 +1150,138 @@ </dl></div> <div class="paragraph"><p>See also <a href="#FILES">[FILES]</a>.</p></div> </div> +</div> +<div class="sect1"> <h2 id="EXAMPLES">EXAMPLES</h2> <div class="sectionbody"> <div class="paragraph"><p>Given a .git/config like this:</p></div> <div class="literalblock"> <div class="content"> -<pre><tt># +<pre><code># # This is the config file, and # a '#' or ';' character indicates # a comment -#</tt></pre> +#</code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt>; core variables +<pre><code>; core variables [core] ; Don't trust file modes - filemode = false</tt></pre> + filemode = false</code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt>; Our diff algorithm +<pre><code>; Our diff algorithm [diff] external = /usr/local/bin/diff-wrapper - renames = true</tt></pre> + renames = true</code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt>; Proxy settings +<pre><code>; Proxy settings [core] gitproxy=proxy-command for kernel.org - gitproxy=default-proxy ; for all the rest</tt></pre> + gitproxy=default-proxy ; for all the rest</code></pre> </div></div> <div class="paragraph"><p>you can set the filemode to true with</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config core.filemode true</tt></pre> +<pre><code>% git config core.filemode true</code></pre> </div></div> <div class="paragraph"><p>The hypothetical proxy command entries actually have a postfix to discern what URL they apply to. Here is how to change the entry for kernel.org to "ssh".</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</tt></pre> +<pre><code>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</code></pre> </div></div> <div class="paragraph"><p>This makes sure that only the key/value pair for kernel.org is replaced.</p></div> <div class="paragraph"><p>To delete the entry for renames, do</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config --unset diff.renames</tt></pre> +<pre><code>% git config --unset diff.renames</code></pre> </div></div> <div class="paragraph"><p>If you want to delete an entry for a multivar (like core.gitproxy above), you have to provide a regex matching the value of exactly one line.</p></div> <div class="paragraph"><p>To query the value for a given key, do</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config --get core.filemode</tt></pre> +<pre><code>% git config --get core.filemode</code></pre> </div></div> <div class="paragraph"><p>or</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config core.filemode</tt></pre> +<pre><code>% git config core.filemode</code></pre> </div></div> <div class="paragraph"><p>or, to query a multivar:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config --get core.gitproxy "for kernel.org$"</tt></pre> +<pre><code>% git config --get core.gitproxy "for kernel.org$"</code></pre> </div></div> <div class="paragraph"><p>If you want to know all the values for a multivar, do:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config --get-all core.gitproxy</tt></pre> +<pre><code>% git config --get-all core.gitproxy</code></pre> </div></div> <div class="paragraph"><p>If you like to live dangerously, you can replace <strong>all</strong> core.gitproxy by a new one with</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config --replace-all core.gitproxy ssh</tt></pre> +<pre><code>% git config --replace-all core.gitproxy ssh</code></pre> </div></div> <div class="paragraph"><p>However, if you really only want to replace the line for the default proxy, i.e. the one without a "for …" postfix, do something like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config core.gitproxy ssh '! for '</tt></pre> +<pre><code>% git config core.gitproxy ssh '! for '</code></pre> </div></div> <div class="paragraph"><p>To actually match only values with an exclamation mark, you have to</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config section.key value '[!]'</tt></pre> +<pre><code>% git config section.key value '[!]'</code></pre> </div></div> <div class="paragraph"><p>To add a new proxy, without altering any of the existing ones, use</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>% git config --add core.gitproxy '"proxy-command" for example.com'</tt></pre> +<pre><code>% git config --add core.gitproxy '"proxy-command" for example.com'</code></pre> </div></div> <div class="paragraph"><p>An example to use customized color from the configuration in your script:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>#!/bin/sh +<pre><code>#!/bin/sh WS=$(git config --get-color color.diff.whitespace "blue reverse") RESET=$(git config --get-color "" "reset") -echo "${WS}your whitespace color or blue reverse${RESET}"</tt></pre> +echo "${WS}your whitespace color or blue reverse${RESET}"</code></pre> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_configuration_file">CONFIGURATION FILE</h2> <div class="sectionbody"> <div class="paragraph"><p>The git configuration file contains a number of variables that affect -the git command’s behavior. The <tt>.git/config</tt> file in each repository +the git command’s behavior. The <code>.git/config</code> file in each repository is used to store the configuration for that repository, and -<tt>$HOME/.gitconfig</tt> is used to store a per-user configuration as -fallback values for the <tt>.git/config</tt> file. The file <tt>/etc/gitconfig</tt> +<code>$HOME/.gitconfig</code> is used to store a per-user configuration as +fallback values for the <code>.git/config</code> file. The file <code>/etc/gitconfig</code> can be used to store a system-wide default configuration.</p></div> <div class="paragraph"><p>The configuration variables are used by both the git plumbing and the porcelains. The variables are divided into sections, wherein the fully qualified variable name of the variable itself is the last dot-separated segment and the section name is everything before the last dot. The variable names are case-insensitive, allow only alphanumeric -characters and <tt>-</tt>, and must start with an alphabetic character. Some +characters and <code>-</code>, and must start with an alphabetic character. Some variables may appear multiple times.</p></div> -<h3 id="_syntax">Syntax</h3><div style="clear:left"></div> +<div class="sect2"> +<h3 id="_syntax">Syntax</h3> <div class="paragraph"><p>The syntax is fairly flexible and permissive; whitespaces are mostly ignored. The <em>#</em> and <em>;</em> characters begin comments to the end of line, blank lines are ignored.</p></div> <div class="paragraph"><p>The file consists of sections and variables. A section begins with the name of the section in square brackets and continues until the next section begins. Section names are not case sensitive. Only alphanumeric -characters, <tt>-</tt> and <tt>.</tt> are allowed in section names. Each variable +characters, <code>-</code> and <code>.</code> are allowed in section names. Each variable must belong to some section, which means that there must be a section header before the first setting of a variable.</p></div> <div class="paragraph"><p>Sections can be further divided into subsections. To begin a subsection @@ -1113,15 +1289,15 @@ in the section header, like in the example below:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> [section "subsection"]</tt></pre> +<pre><code> [section "subsection"]</code></pre> </div></div> <div class="paragraph"><p>Subsection names are case sensitive and can contain any characters except -newline (doublequote <tt>"</tt> and backslash have to be escaped as <tt>\"</tt> and <tt>\\</tt>, +newline (doublequote <code>"</code> and backslash have to be escaped as <code>\"</code> and <code>\\</code>, respectively). Section headers cannot span multiple lines. Variables may belong directly to a section or to a given subsection. -You can have <tt>[section]</tt> if you have <tt>[section "subsection"]</tt>, but you +You can have <code>[section]</code> if you have <code>[section "subsection"]</code>, but you don’t need to.</p></div> -<div class="paragraph"><p>There is also a deprecated <tt>[section.subsection]</tt> syntax. With this +<div class="paragraph"><p>There is also a deprecated <code>[section.subsection]</code> syntax. With this syntax, the subsection name is converted to lower-case and is also compared case sensitively. These subsection names follow the same restrictions as section names.</p></div> @@ -1130,7 +1306,7 @@ <em>name = value</em>. If there is no equal sign on the line, the entire line is taken as <em>name</em> and the variable is recognized as boolean "true". The variable names are case-insensitive, allow only alphanumeric characters -and <tt>-</tt>, and must start with an alphabetic character. There can be more +and <code>-</code>, and must start with an alphabetic character. There can be more than one value for a given variable; we say then that the variable is multivalued.</p></div> <div class="paragraph"><p>Leading and trailing whitespace in a variable value is discarded. @@ -1144,61 +1320,67 @@ You need to enclose variable values in double quotes if you want to preserve leading or trailing whitespace, or if the variable value contains comment characters (i.e. it contains <em>#</em> or <em>;</em>). -Double quote <tt>"</tt> and backslash <tt>\</tt> characters in variable values must -be escaped: use <tt>\"</tt> for <tt>"</tt> and <tt>\\</tt> for <tt>\</tt>.</p></div> -<div class="paragraph"><p>The following escape sequences (beside <tt>\"</tt> and <tt>\\</tt>) are recognized: -<tt>\n</tt> for newline character (NL), <tt>\t</tt> for horizontal tabulation (HT, TAB) -and <tt>\b</tt> for backspace (BS). No other char escape sequence, nor octal +Double quote <code>"</code> and backslash <code>\</code> characters in variable values must +be escaped: use <code>\"</code> for <code>"</code> and <code>\\</code> for <code>\</code>.</p></div> +<div class="paragraph"><p>The following escape sequences (beside <code>\"</code> and <code>\\</code>) are recognized: +<code>\n</code> for newline character (NL), <code>\t</code> for horizontal tabulation (HT, TAB) +and <code>\b</code> for backspace (BS). No other char escape sequence, nor octal char sequences are valid.</p></div> -<div class="paragraph"><p>Variable values ending in a <tt>\</tt> are continued on the next line in the +<div class="paragraph"><p>Variable values ending in a <code>\</code> are continued on the next line in the customary UNIX fashion.</p></div> <div class="paragraph"><p>Some variables may require a special value format.</p></div> -<h3 id="_includes">Includes</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_includes">Includes</h3> <div class="paragraph"><p>You can include one config file from another by setting the special -<tt>include.path</tt> variable to the name of the file to be included. The +<code>include.path</code> variable to the name of the file to be included. The included file is expanded immediately, as if its contents had been found at the location of the include directive. If the value of the -<tt>include.path</tt> variable is a relative path, the path is considered to be +<code>include.path</code> variable is a relative path, the path is considered to be relative to the configuration file in which the include directive was -found. The value of <tt>include.path</tt> is subject to tilde expansion: <tt>~/</tt> -is expanded to the value of <tt>$HOME</tt>, and <tt>~user/</tt> to the specified +found. The value of <code>include.path</code> is subject to tilde expansion: <code>~/</code> +is expanded to the value of <code>$HOME</code>, and <code>~user/</code> to the specified user’s home directory. See below for examples.</p></div> -<h3 id="_example">Example</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_example">Example</h3> <div class="literalblock"> <div class="content"> -<pre><tt># Core variables +<pre><code># Core variables [core] ; Don't trust file modes - filemode = false</tt></pre> + filemode = false</code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt># Our diff algorithm +<pre><code># Our diff algorithm [diff] external = /usr/local/bin/diff-wrapper - renames = true</tt></pre> + renames = true</code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt>[branch "devel"] +<pre><code>[branch "devel"] remote = origin - merge = refs/heads/devel</tt></pre> + merge = refs/heads/devel</code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt># Proxy settings +<pre><code># Proxy settings [core] gitProxy="ssh" for "kernel.org" - gitProxy=default-proxy ; for the rest</tt></pre> + gitProxy=default-proxy ; for the rest</code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt>[include] +<pre><code>[include] path = /path/to/foo.inc ; include by absolute path path = foo ; expand "foo" relative to the current file - path = ~/foo ; expand "foo" in your $HOME directory</tt></pre> + path = ~/foo ; expand "foo" in your $HOME directory</code></pre> </div></div> -<h3 id="_variables">Variables</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_variables">Variables</h3> <div class="paragraph"><p>Note that this list is non-comprehensive and not necessarily complete. For command-specific variables, you will find a more detailed description in the appropriate manual page. You will find a description of non-core @@ -1213,6 +1395,8 @@ aid new users. All <em>advice.*</em> variables default to <em>true</em>, and you can tell Git that you do not need help by setting these to <em>false</em>: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> pushNonFastForward @@ -1316,6 +1500,7 @@ </p> </dd> </dl></div> +</div></div> </dd> <dt class="hdlist1"> core.fileMode @@ -1394,14 +1579,14 @@ <dd> <p> The commands that output paths (e.g. <em>ls-files</em>, - <em>diff</em>), when not given the <tt>-z</tt> option, will quote + <em>diff</em>), when not given the <code>-z</code> option, will quote "unusual" characters in the pathname by enclosing the pathname in a double-quote pair and with backslashes the same way strings in C source code are quoted. If this variable is set to false, the bytes higher than 0x80 are not quoted but output as verbatim. Note that double quote, backslash and control characters are always - quoted without <tt>-z</tt> regardless of the setting of this + quoted without <code>-z</code> regardless of the setting of this variable. </p> </dd> @@ -1411,9 +1596,9 @@ <dd> <p> Sets the line ending type to use in the working directory for - files that have the <tt>text</tt> property set. Alternatives are + files that have the <code>text</code> property set. Alternatives are <em>lf</em>, <em>crlf</em> and <em>native</em>, which uses the platform’s native - line ending. The default value is <tt>native</tt>. See + line ending. The default value is <code>native</code>. See <a href="gitattributes.html">gitattributes(5)</a> for more information on end-of-line conversion. </p> @@ -1423,13 +1608,13 @@ </dt> <dd> <p> - If true, makes git check if converting <tt>CRLF</tt> is reversible when + If true, makes git check if converting <code>CRLF</code> is reversible when end-of-line conversion is active. Git will verify if a command modifies a file in the work tree either directly or indirectly. For example, committing a file followed by checking out the same file should yield the original file in the work tree. If this is not the case for the current setting of - <tt>core.autocrlf</tt>, git will reject the file. The variable can + <code>core.autocrlf</code>, git will reject the file. The variable can be set to "warn", in which case git will only warn about an irreversible conversion but continue the operation. </p> @@ -1455,13 +1640,13 @@ converting CRLFs corrupts data.</p></div> <div class="paragraph"><p>Note, this safety check does not mean that a checkout will generate a file identical to the original file for a different setting of -<tt>core.eol</tt> and <tt>core.autocrlf</tt>, but only for the current one. For -example, a text file with <tt>LF</tt> would be accepted with <tt>core.eol=lf</tt> -and could later be checked out with <tt>core.eol=crlf</tt>, in which case the -resulting file would contain <tt>CRLF</tt>, although the original file -contained <tt>LF</tt>. However, in both work trees the line endings would be -consistent, that is either all <tt>LF</tt> or all <tt>CRLF</tt>, but never mixed. A -file with mixed line endings would be reported by the <tt>core.safecrlf</tt> +<code>core.eol</code> and <code>core.autocrlf</code>, but only for the current one. For +example, a text file with <code>LF</code> would be accepted with <code>core.eol=lf</code> +and could later be checked out with <code>core.eol=crlf</code>, in which case the +resulting file would contain <code>CRLF</code>, although the original file +contained <code>LF</code>. However, in both work trees the line endings would be +consistent, that is either all <code>LF</code> or all <code>CRLF</code>, but never mixed. A +file with mixed line endings would be reported by the <code>core.safecrlf</code> mechanism.</p></div> </dd> <dt class="hdlist1"> @@ -1470,10 +1655,10 @@ <dd> <p> Setting this variable to "true" is almost the same as setting - the <tt>text</tt> attribute to "auto" on all files except that text + the <code>text</code> attribute to "auto" on all files except that text files are not guaranteed to be normalized: files that contain - <tt>CRLF</tt> in the repository will not be touched. Use this - setting if you want to have <tt>CRLF</tt> line endings in your + <code>CRLF</code> in the repository will not be touched. Use this + setting if you want to have <code>CRLF</code> line endings in your working directory even though the repository does not have normalized line endings. This variable can be set to <em>input</em>, in which case no output conversion is performed. @@ -1510,7 +1695,7 @@ <div class="paragraph"><p>Can be overridden by the <em>GIT_PROXY_COMMAND</em> environment variable (which always applies universally, without the special "for" handling).</p></div> -<div class="paragraph"><p>The special string <tt>none</tt> can be used as the proxy command to +<div class="paragraph"><p>The special string <code>none</code> can be used as the proxy command to specify that no proxy be used for a given domain pattern. This is useful for excluding servers inside a firewall from proxy use, while defaulting to a common proxy for external domains.</p></div> @@ -1737,8 +1922,8 @@ <p> In addition to <em>.gitignore</em> (per-directory) and <em>.git/info/exclude</em>, git looks into this file for patterns - of files which are not meant to be tracked. "<tt>~/</tt>" is expanded - to the value of <tt>$HOME</tt> and "<tt>~user/</tt>" to the specified user’s + of files which are not meant to be tracked. "<code>~/</code>" is expanded + to the value of <code>$HOME</code> and "<code>~user/</code>" to the specified user’s home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore is used instead. See <a href="gitignore.html">gitignore(5)</a>. @@ -1766,7 +1951,7 @@ In addition to <em>.gitattributes</em> (per-directory) and <em>.git/info/attributes</em>, git looks into this file for attributes (see <a href="gitattributes.html">gitattributes(5)</a>). Path expansions are made the same - way as for <tt>core.excludesfile</tt>. Its default value is + way as for <code>core.excludesfile</code>. Its default value is $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/attributes is used instead. </p> @@ -1776,10 +1961,10 @@ </dt> <dd> <p> - Commands such as <tt>commit</tt> and <tt>tag</tt> that lets you edit + Commands such as <code>commit</code> and <code>tag</code> that lets you edit messages by launching an editor uses the value of this variable when it is set, and the environment variable - <tt>GIT_EDITOR</tt> is not set. See <a href="git-var.html">git-var(1)</a>. + <code>GIT_EDITOR</code> is not set. See <a href="git-var.html">git-var(1)</a>. </p> </dd> <dt class="hdlist1"> @@ -1787,9 +1972,9 @@ </dt> <dd> <p> - Text editor used by <tt>git rebase -i</tt> for editing the rebase insn file. + Text editor used by <code>git rebase -i</code> for editing the rebase insn file. The value is meant to be interpreted by the shell when it is used. - It can be overridden by the <tt>GIT_SEQUENCE_EDITOR</tt> environment variable. + It can be overridden by the <code>GIT_SEQUENCE_EDITOR</code> environment variable. When not configured the default commit message editor is used instead. </p> </dd> @@ -1799,21 +1984,21 @@ <dd> <p> The command that git will use to paginate output. Can - be overridden with the <tt>GIT_PAGER</tt> environment - variable. Note that git sets the <tt>LESS</tt> environment - variable to <tt>FRSX</tt> if it is unset when it runs the + be overridden with the <code>GIT_PAGER</code> environment + variable. Note that git sets the <code>LESS</code> environment + variable to <code>FRSX</code> if it is unset when it runs the pager. One can change these settings by setting the - <tt>LESS</tt> variable to some other value. Alternately, + <code>LESS</code> variable to some other value. Alternately, these settings can be overridden on a project or - global basis by setting the <tt>core.pager</tt> option. - Setting <tt>core.pager</tt> has no effect on the <tt>LESS</tt> + global basis by setting the <code>core.pager</code> option. + Setting <code>core.pager</code> has no effect on the <code>LESS</code> environment variable behaviour above, so if you want to override git’s default settings this way, you need to be explicit. For example, to disable the S option - in a backward compatible manner, set <tt>core.pager</tt> - to <tt>less -+S</tt>. This will be passed to the shell by + in a backward compatible manner, set <code>core.pager</code> + to <code>less -+S</code>. This will be passed to the shell by git, which will translate the final command to - <tt>LESS=FRSX less -+S</tt>. + <code>LESS=FRSX less -+S</code>. </p> </dd> <dt class="hdlist1"> @@ -1822,62 +2007,62 @@ <dd> <p> A comma separated list of common whitespace problems to - notice. <em>git diff</em> will use <tt>color.diff.whitespace</tt> to + notice. <em>git diff</em> will use <code>color.diff.whitespace</code> to highlight them, and <em>git apply --whitespace=error</em> will - consider them as errors. You can prefix <tt>-</tt> to disable - any of them (e.g. <tt>-trailing-space</tt>): + consider them as errors. You can prefix <code>-</code> to disable + any of them (e.g. <code>-trailing-space</code>): </p> <div class="ulist"><ul> <li> <p> -<tt>blank-at-eol</tt> treats trailing whitespaces at the end of the line +<code>blank-at-eol</code> treats trailing whitespaces at the end of the line as an error (enabled by default). </p> </li> <li> <p> -<tt>space-before-tab</tt> treats a space character that appears immediately +<code>space-before-tab</code> treats a space character that appears immediately before a tab character in the initial indent part of the line as an error (enabled by default). </p> </li> <li> <p> -<tt>indent-with-non-tab</tt> treats a line that is indented with space +<code>indent-with-non-tab</code> treats a line that is indented with space characters instead of the equivalent tabs as an error (not enabled by default). </p> </li> <li> <p> -<tt>tab-in-indent</tt> treats a tab character in the initial indent part of +<code>tab-in-indent</code> treats a tab character in the initial indent part of the line as an error (not enabled by default). </p> </li> <li> <p> -<tt>blank-at-eof</tt> treats blank lines added at the end of file as an error +<code>blank-at-eof</code> treats blank lines added at the end of file as an error (enabled by default). </p> </li> <li> <p> -<tt>trailing-space</tt> is a short-hand to cover both <tt>blank-at-eol</tt> and - <tt>blank-at-eof</tt>. +<code>trailing-space</code> is a short-hand to cover both <code>blank-at-eol</code> and + <code>blank-at-eof</code>. </p> </li> <li> <p> -<tt>cr-at-eol</tt> treats a carriage-return at the end of line as - part of the line terminator, i.e. with it, <tt>trailing-space</tt> +<code>cr-at-eol</code> treats a carriage-return at the end of line as + part of the line terminator, i.e. with it, <code>trailing-space</code> does not trigger if the character before such a carriage-return is not a whitespace (not enabled by default). </p> </li> <li> <p> -<tt>tabwidth=<n></tt> tells how many character positions a tab occupies; this - is relevant for <tt>indent-with-non-tab</tt> and when git fixes <tt>tab-in-indent</tt> +<code>tabwidth=<n></code> tells how many character positions a tab occupies; this + is relevant for <code>indent-with-non-tab</code> and when git fixes <code>tab-in-indent</code> errors. The default tab width is 8. Allowed values are 1 to 63. </p> </li> @@ -1965,9 +2150,9 @@ Tells <em>git add</em> to continue adding files when some files cannot be added due to indexing errors. Equivalent to the <em>--ignore-errors</em> option of <a href="git-add.html">git-add(1)</a>. Older versions of git accept only - <tt>add.ignore-errors</tt>, which does not follow the usual naming + <code>add.ignore-errors</code>, which does not follow the usual naming convention for configuration variables. Newer versions of git - honor <tt>add.ignoreErrors</tt> as well. + honor <code>add.ignoreErrors</code> as well. </p> </dd> <dt class="hdlist1"> @@ -2000,7 +2185,7 @@ <p> If true, git-am will call git-mailsplit for patches in mbox format with parameter <em>--keep-cr</em>. In this case git-mailsplit will - not remove <tt>\r</tt> from lines ending with <tt>\r\n</tt>. Can be overridden + not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden by giving <em>--no-keep-cr</em> from the command line. See <a href="git-am.html">git-am(1)</a>, <a href="git-mailsplit.html">git-mailsplit(1)</a>. </p> @@ -2035,10 +2220,10 @@ Tells <em>git branch</em> and <em>git checkout</em> to set up new branches so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the starting point branch. Note that even if this option is not set, - this behavior can be chosen per-branch using the <tt>--track</tt> - and <tt>--no-track</tt> options. The valid settings are: <tt>false</tt> — no - automatic setup is done; <tt>true</tt> — automatic setup is done when the - starting point is a remote-tracking branch; <tt>always</tt> —  automatic setup is done when the starting point is either a + this behavior can be chosen per-branch using the <code>--track</code> + and <code>--no-track</code> options. The valid settings are: <code>false</code> — no + automatic setup is done; <code>true</code> — automatic setup is done when the + starting point is a remote-tracking branch; <code>always</code> —  automatic setup is done when the starting point is either a local branch or remote-tracking branch. This option defaults to true. </p> @@ -2051,12 +2236,12 @@ When a new branch is created with <em>git branch</em> or <em>git checkout</em> that tracks another branch, this variable tells git to set up pull to rebase instead of merge (see "branch.<name>.rebase"). - When <tt>never</tt>, rebase is never automatically set to true. - When <tt>local</tt>, rebase is set to true for tracked branches of + When <code>never</code>, rebase is never automatically set to true. + When <code>local</code>, rebase is set to true for tracked branches of other local branches. - When <tt>remote</tt>, rebase is set to true for tracked branches of + When <code>remote</code>, rebase is set to true for tracked branches of remote-tracking branches. - When <tt>always</tt>, rebase will be set to true for all tracking + When <code>always</code>, rebase will be set to true for all tracking branches. See "branch.autosetupmerge" for details on how to set up a branch to track another branch. @@ -2069,8 +2254,8 @@ <dd> <p> When in branch <name>, it tells <em>git fetch</em> and <em>git push</em> which - remote to fetch from/push to. It defaults to <tt>origin</tt> if no remote is - configured. <tt>origin</tt> is also used if you are not on any branch. + remote to fetch from/push to. It defaults to <code>origin</code> if no remote is + configured. <code>origin</code> is also used if you are not on any branch. </p> </dd> <dt class="hdlist1"> @@ -2093,7 +2278,7 @@ If you wish to setup <em>git pull</em> so that it merges into <name> from another branch in the local repository, you can point branch.<name>.merge to the desired branch, and use the special setting - <tt>.</tt> (a period) for branch.<name>.remote. + <code>.</code> (a period) for branch.<name>.remote. </p> </dd> <dt class="hdlist1"> @@ -2156,8 +2341,8 @@ <dd> <p> A boolean to enable/disable color in the output of - <a href="git-branch.html">git-branch(1)</a>. May be set to <tt>always</tt>, - <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used + <a href="git-branch.html">git-branch(1)</a>. May be set to <code>always</code>, + <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used only when the output is to a terminal. Defaults to false. </p> </dd> @@ -2166,16 +2351,16 @@ </dt> <dd> <p> - Use customized color for branch coloration. <tt><slot></tt> is one of - <tt>current</tt> (the current branch), <tt>local</tt> (a local branch), - <tt>remote</tt> (a remote-tracking branch in refs/remotes/), <tt>plain</tt> (other + Use customized color for branch coloration. <code><slot></code> is one of + <code>current</code> (the current branch), <code>local</code> (a local branch), + <code>remote</code> (a remote-tracking branch in refs/remotes/), <code>plain</code> (other refs). </p> <div class="paragraph"><p>The value for these configuration variables is a list of colors (at most two) and attributes (at most one), separated by spaces. The colors -accepted are <tt>normal</tt>, <tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>yellow</tt>, <tt>blue</tt>, -<tt>magenta</tt>, <tt>cyan</tt> and <tt>white</tt>; the attributes are <tt>bold</tt>, <tt>dim</tt>, <tt>ul</tt>, -<tt>blink</tt> and <tt>reverse</tt>. The first color given is the foreground; the +accepted are <code>normal</code>, <code>black</code>, <code>red</code>, <code>green</code>, <code>yellow</code>, <code>blue</code>, +<code>magenta</code>, <code>cyan</code> and <code>white</code>; the attributes are <code>bold</code>, <code>dim</code>, <code>ul</code>, +<code>blink</code> and <code>reverse</code>. The first color given is the foreground; the second is the background. The position of the attribute, if any, doesn’t matter.</p></div> </dd> @@ -2185,26 +2370,26 @@ <dd> <p> Whether to use ANSI escape sequences to add color to patches. - If this is set to <tt>always</tt>, <a href="git-diff.html">git-diff(1)</a>, + If this is set to <code>always</code>, <a href="git-diff.html">git-diff(1)</a>, <a href="git-log.html">git-log(1)</a>, and <a href="git-show.html">git-show(1)</a> will use color - for all patches. If it is set to <tt>true</tt> or <tt>auto</tt>, those + for all patches. If it is set to <code>true</code> or <code>auto</code>, those commands will only use color when output is to the terminal. Defaults to false. </p> <div class="paragraph"><p>This does not affect <a href="git-format-patch.html">git-format-patch(1)</a> nor the <em>git-diff-*</em> plumbing commands. Can be overridden on the -command line with the <tt>--color[=<when>]</tt> option.</p></div> +command line with the <code>--color[=<when>]</code> option.</p></div> </dd> <dt class="hdlist1"> color.diff.<slot> </dt> <dd> <p> - Use customized color for diff colorization. <tt><slot></tt> specifies + Use customized color for diff colorization. <code><slot></code> specifies which part of the patch to use the specified color, and is one - of <tt>plain</tt> (context text), <tt>meta</tt> (metainformation), <tt>frag</tt> - (hunk header), <em>func</em> (function in hunk header), <tt>old</tt> (removed lines), - <tt>new</tt> (added lines), <tt>commit</tt> (commit headers), or <tt>whitespace</tt> + of <code>plain</code> (context text), <code>meta</code> (metainformation), <code>frag</code> + (hunk header), <em>func</em> (function in hunk header), <code>old</code> (removed lines), + <code>new</code> (added lines), <code>commit</code> (commit headers), or <code>whitespace</code> (highlighting whitespace errors). The values of these variables may be specified as in color.branch.<slot>. </p> @@ -2214,8 +2399,8 @@ </dt> <dd> <p> - Use customized color for <em>git log --decorate</em> output. <tt><slot></tt> is one - of <tt>branch</tt>, <tt>remoteBranch</tt>, <tt>tag</tt>, <tt>stash</tt> or <tt>HEAD</tt> for local + Use customized color for <em>git log --decorate</em> output. <code><slot></code> is one + of <code>branch</code>, <code>remoteBranch</code>, <code>tag</code>, <code>stash</code> or <code>HEAD</code> for local branches, remote-tracking branches, tags, stash and HEAD, respectively. </p> </dd> @@ -2224,9 +2409,9 @@ </dt> <dd> <p> - When set to <tt>always</tt>, always highlight matches. When <tt>false</tt> (or - <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use color only - when the output is written to the terminal. Defaults to <tt>false</tt>. + When set to <code>always</code>, always highlight matches. When <code>false</code> (or + <code>never</code>), never. When set to <code>true</code> or <code>auto</code>, use color only + when the output is written to the terminal. Defaults to <code>false</code>. </p> </dd> <dt class="hdlist1"> @@ -2234,44 +2419,46 @@ </dt> <dd> <p> - Use customized color for grep colorization. <tt><slot></tt> specifies which + Use customized color for grep colorization. <code><slot></code> specifies which part of the line to use the specified color, and is one of </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>context</tt> +<code>context</code> </dt> <dd> <p> - non-matching text in context lines (when using <tt>-A</tt>, <tt>-B</tt>, or <tt>-C</tt>) + non-matching text in context lines (when using <code>-A</code>, <code>-B</code>, or <code>-C</code>) </p> </dd> <dt class="hdlist1"> -<tt>filename</tt> +<code>filename</code> </dt> <dd> <p> - filename prefix (when not using <tt>-h</tt>) + filename prefix (when not using <code>-h</code>) </p> </dd> <dt class="hdlist1"> -<tt>function</tt> +<code>function</code> </dt> <dd> <p> - function name lines (when using <tt>-p</tt>) + function name lines (when using <code>-p</code>) </p> </dd> <dt class="hdlist1"> -<tt>linenumber</tt> +<code>linenumber</code> </dt> <dd> <p> - line number prefix (when using <tt>-n</tt>) + line number prefix (when using <code>-n</code>) </p> </dd> <dt class="hdlist1"> -<tt>match</tt> +<code>match</code> </dt> <dd> <p> @@ -2279,7 +2466,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>selected</tt> +<code>selected</code> </dt> <dd> <p> @@ -2287,15 +2474,16 @@ </p> </dd> <dt class="hdlist1"> -<tt>separator</tt> +<code>separator</code> </dt> <dd> <p> - separators between fields on a line (<tt>:</tt>, <tt>-</tt>, and <tt>=</tt>) - and between hunks (<tt>--</tt>) + separators between fields on a line (<code>:</code>, <code>-</code>, and <code>=</code>) + and between hunks (<code>--</code>) </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>The values of these variables may be specified as in color.branch.<slot>.</p></div> </dd> <dt class="hdlist1"> @@ -2303,9 +2491,9 @@ </dt> <dd> <p> - When set to <tt>always</tt>, always use colors for interactive prompts + When set to <code>always</code>, always use colors for interactive prompts and displays (such as those used by "git-add --interactive"). - When false (or <tt>never</tt>), never. When set to <tt>true</tt> or <tt>auto</tt>, use + When false (or <code>never</code>), never. When set to <code>true</code> or <code>auto</code>, use colors only when the output is to the terminal. Defaults to false. </p> </dd> @@ -2315,7 +2503,7 @@ <dd> <p> Use customized color for <em>git add --interactive</em> - output. <tt><slot></tt> may be <tt>prompt</tt>, <tt>header</tt>, <tt>help</tt> or <tt>error</tt>, for + output. <code><slot></code> may be <code>prompt</code>, <code>header</code>, <code>help</code> or <code>error</code>, for four distinct types of normal output from interactive commands. The values of these variables may be specified as in color.branch.<slot>. @@ -2336,8 +2524,8 @@ <dd> <p> A boolean to enable/disable color in the output of - <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <tt>always</tt>, - <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used + <a href="git-show-branch.html">git-show-branch(1)</a>. May be set to <code>always</code>, + <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used only when the output is to a terminal. Defaults to false. </p> </dd> @@ -2347,8 +2535,8 @@ <dd> <p> A boolean to enable/disable color in the output of - <a href="git-status.html">git-status(1)</a>. May be set to <tt>always</tt>, - <tt>false</tt> (or <tt>never</tt>) or <tt>auto</tt> (or <tt>true</tt>), in which case colors are used + <a href="git-status.html">git-status(1)</a>. May be set to <code>always</code>, + <code>false</code> (or <code>never</code>) or <code>auto</code> (or <code>true</code>), in which case colors are used only when the output is to a terminal. Defaults to false. </p> </dd> @@ -2357,13 +2545,13 @@ </dt> <dd> <p> - Use customized color for status colorization. <tt><slot></tt> is - one of <tt>header</tt> (the header text of the status message), - <tt>added</tt> or <tt>updated</tt> (files which are added but not committed), - <tt>changed</tt> (files which are changed but not added in the index), - <tt>untracked</tt> (files which are not tracked by git), - <tt>branch</tt> (the current branch), or - <tt>nobranch</tt> (the color the <em>no branch</em> warning is shown in, defaulting + Use customized color for status colorization. <code><slot></code> is + one of <code>header</code> (the header text of the status message), + <code>added</code> or <code>updated</code> (files which are added but not committed), + <code>changed</code> (files which are changed but not added in the index), + <code>untracked</code> (files which are not tracked by git), + <code>branch</code> (the current branch), or + <code>nobranch</code> (the color the <em>no branch</em> warning is shown in, defaulting to red). The values of these variables may be specified as in color.branch.<slot>. </p> @@ -2374,14 +2562,14 @@ <dd> <p> This variable determines the default value for variables such - as <tt>color.diff</tt> and <tt>color.grep</tt> that control the use of color + as <code>color.diff</code> and <code>color.grep</code> that control the use of color per command family. Its scope will expand as more commands learn - configuration to set a default for the <tt>--color</tt> option. Set it - to <tt>always</tt> if you want all output not intended for machine - consumption to use color, to <tt>true</tt> or <tt>auto</tt> if you want such - output to use color when written to the terminal, or to <tt>false</tt> or - <tt>never</tt> if you prefer git commands not to use color unless enabled - explicitly with some other configuration or the <tt>--color</tt> option. + configuration to set a default for the <code>--color</code> option. Set it + to <code>always</code> if you want all output not intended for machine + consumption to use color, to <code>true</code> or <code>auto</code> if you want such + output to use color when written to the terminal, or to <code>false</code> or + <code>never</code> if you prefer git commands not to use color unless enabled + explicitly with some other configuration or the <code>--color</code> option. </p> </dd> <dt class="hdlist1"> @@ -2393,9 +2581,11 @@ This variable consists of a list of tokens separated by spaces or commas: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>always</tt> +<code>always</code> </dt> <dd> <p> @@ -2403,7 +2593,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>never</tt> +<code>never</code> </dt> <dd> <p> @@ -2411,7 +2601,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>auto</tt> +<code>auto</code> </dt> <dd> <p> @@ -2419,7 +2609,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>column</tt> +<code>column</code> </dt> <dd> <p> @@ -2427,7 +2617,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>row</tt> +<code>row</code> </dt> <dd> <p> @@ -2435,7 +2625,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>plain</tt> +<code>plain</code> </dt> <dd> <p> @@ -2443,7 +2633,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>dense</tt> +<code>dense</code> </dt> <dd> <p> @@ -2451,7 +2641,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>nodense</tt> +<code>nodense</code> </dt> <dd> <p> @@ -2459,6 +2649,7 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>This option defaults to <em>never</em>.</p></div> </dd> <dt class="hdlist1"> @@ -2466,8 +2657,8 @@ </dt> <dd> <p> - Specify whether to output branch listing in <tt>git branch</tt> in columns. - See <tt>column.ui</tt> for details. + Specify whether to output branch listing in <code>git branch</code> in columns. + See <code>column.ui</code> for details. </p> </dd> <dt class="hdlist1"> @@ -2475,8 +2666,8 @@ </dt> <dd> <p> - Specify whether to output untracked files in <tt>git status</tt> in columns. - See <tt>column.ui</tt> for details. + Specify whether to output untracked files in <code>git status</code> in columns. + See <code>column.ui</code> for details. </p> </dd> <dt class="hdlist1"> @@ -2484,8 +2675,8 @@ </dt> <dd> <p> - Specify whether to output tag listing in <tt>git tag</tt> in columns. - See <tt>column.ui</tt> for details. + Specify whether to output tag listing in <code>git tag</code> in columns. + See <code>column.ui</code> for details. </p> </dd> <dt class="hdlist1"> @@ -2504,7 +2695,7 @@ <dd> <p> Specify a file to use as the template for new commit messages. - "<tt>~/</tt>" is expanded to the value of <tt>$HOME</tt> and "<tt>~user/</tt>" to the + "<code>~/</code>" is expanded to the value of <code>$HOME</code> and "<code>~user/</code>" to the specified user’s home directory. </p> </dd> @@ -2558,7 +2749,7 @@ <p> When using <em>git diff</em> to compare with work tree files, do not consider stat-only change as changed. - Instead, silently run <tt>git update-index --refresh</tt> to + Instead, silently run <code>git update-index --refresh</code> to update the cached stat information for paths whose contents in the work tree match the contents in the index. This option defaults to true. Note that this @@ -2571,16 +2762,18 @@ </dt> <dd> <p> - A comma separated list of <tt>--dirstat</tt> parameters specifying the - default behavior of the <tt>--dirstat</tt> option to <a href="git-diff.html">git-diff(1)</a>` + A comma separated list of <code>--dirstat</code> parameters specifying the + default behavior of the <code>--dirstat</code> option to <a href="git-diff.html">git-diff(1)</a>` and friends. The defaults can be overridden on the command line - (using <tt>--dirstat=<param1,param2,...></tt>). The fallback defaults - (when not changed by <tt>diff.dirstat</tt>) are <tt>changes,noncumulative,3</tt>. + (using <code>--dirstat=<param1,param2,...></code>). The fallback defaults + (when not changed by <code>diff.dirstat</code>) are <code>changes,noncumulative,3</code>. The following parameters are available: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>changes</tt> +<code>changes</code> </dt> <dd> <p> @@ -2592,39 +2785,39 @@ </p> </dd> <dt class="hdlist1"> -<tt>lines</tt> +<code>lines</code> </dt> <dd> <p> Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no - natural concept of lines). This is a more expensive <tt>--dirstat</tt> - behavior than the <tt>changes</tt> behavior, but it does count rearranged + natural concept of lines). This is a more expensive <code>--dirstat</code> + behavior than the <code>changes</code> behavior, but it does count rearranged lines within a file as much as other changes. The resulting output - is consistent with what you get from the other <tt>--*stat</tt> options. + is consistent with what you get from the other <code>--*stat</code> options. </p> </dd> <dt class="hdlist1"> -<tt>files</tt> +<code>files</code> </dt> <dd> <p> Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is - the computationally cheapest <tt>--dirstat</tt> behavior, since it does + the computationally cheapest <code>--dirstat</code> behavior, since it does not have to look at the file contents at all. </p> </dd> <dt class="hdlist1"> -<tt>cumulative</tt> +<code>cumulative</code> </dt> <dd> <p> Count changes in a child directory for the parent directory as well. - Note that when using <tt>cumulative</tt>, the sum of the percentages + Note that when using <code>cumulative</code>, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can - be specified with the <tt>noncumulative</tt> parameter. + be specified with the <code>noncumulative</code> parameter. </p> </dd> <dt class="hdlist1"> @@ -2638,10 +2831,11 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: -<tt>files,10,cumulative</tt>.</p></div> +<code>files,10,cumulative</code>.</p></div> </dd> <dt class="hdlist1"> diff.statGraphWidth @@ -2698,7 +2892,7 @@ </p> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>git diff</tt> +<code>git diff</code> </dt> <dd> <p> @@ -2706,7 +2900,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git diff HEAD</tt> +<code>git diff HEAD</code> </dt> <dd> <p> @@ -2714,7 +2908,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git diff --cached</tt> +<code>git diff --cached</code> </dt> <dd> <p> @@ -2722,7 +2916,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git diff HEAD:file1 file2</tt> +<code>git diff HEAD:file1 file2</code> </dt> <dd> <p> @@ -2730,7 +2924,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git diff --no-index a b</tt> +<code>git diff --no-index a b</code> </dt> <dd> <p> @@ -2782,7 +2976,7 @@ <p> Specify the format in which differences in submodules are shown. The "log" format lists the commits in the range like - <a href="git-submodule.html">git-submodule(1)</a> <tt>summary</tt> does. The "short" format + <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. The "short" format format just shows the names of the commits at the beginning and end of the range. Defaults to short. </p> @@ -2862,10 +3056,10 @@ <dd> <p> The diff tool to be used by <a href="git-difftool.html">git-difftool(1)</a>. This - option overrides <tt>merge.tool</tt>, and has the same valid built-in - values as <tt>merge.tool</tt> minus "tortoisemerge" and plus + option overrides <code>merge.tool</code>, and has the same valid built-in + values as <code>merge.tool</code> minus "tortoisemerge" and plus "kompare". Any other value is treated as a custom diff tool, - and there must be a corresponding <tt>difftool.<tool>.cmd</tt> + and there must be a corresponding <code>difftool.<tool>.cmd</code> option. </p> </dd> @@ -2921,7 +3115,7 @@ If it is set to true, git-fetch-pack will check all fetched objects. It will abort in the case of a malformed object or a broken link. The result of an abort are only dangling objects. - Defaults to false. If not set, the value of <tt>transfer.fsckObjects</tt> + Defaults to false. If not set, the value of <code>transfer.fsckObjects</code> is used instead. </p> </dd> @@ -2938,7 +3132,7 @@ a pack, after adding any missing delta bases. Storing the pack from a push can make the push operation complete faster, especially on slow filesystems. If not set, the value of - <tt>transfer.unpackLimit</tt> is used instead. + <code>transfer.unpackLimit</code> is used instead. </p> </dd> <dt class="hdlist1"> @@ -3013,7 +3207,7 @@ <dd> <p> The default for format-patch is to output files with the suffix - <tt>.patch</tt>. Use this variable to change that suffix (make sure to + <code>.patch</code>. Use this variable to change that suffix (make sure to include the dot if you want it). </p> </dd> @@ -3033,12 +3227,12 @@ <dd> <p> The default threading style for <em>git format-patch</em>. Can be - a boolean value, or <tt>shallow</tt> or <tt>deep</tt>. <tt>shallow</tt> threading + a boolean value, or <code>shallow</code> or <code>deep</code>. <code>shallow</code> threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the - <tt>--in-reply-to</tt>, and the first patch mail, in this order. - <tt>deep</tt> threading makes every mail a reply to the previous one. - A true boolean value is the same as <tt>shallow</tt>, and a false + <code>--in-reply-to</code>, and the first patch mail, in this order. + <code>deep</code> threading makes every mail a reply to the previous one. + A true boolean value is the same as <code>shallow</code>, and a false value disables threading. </p> </dd> @@ -3047,7 +3241,7 @@ </dt> <dd> <p> - A boolean value which lets you enable the <tt>-s/--signoff</tt> option of + A boolean value which lets you enable the <code>-s/--signoff</code> option of format-patch by default. <strong>Note:</strong> Adding the Signed-off-by: line to a patch should be a conscious act and means that you certify you have the rights to submit this work under the same open source license. @@ -3090,7 +3284,7 @@ <dd> <p> When there are approximately more than this many loose - objects in the repository, <tt>git gc --auto</tt> will pack them. + objects in the repository, <code>git gc --auto</code> will pack them. Some Porcelain commands use this command to perform a light-weight garbage collection from time to time. The default value is 6700. Setting this to 0 disables it. @@ -3102,8 +3296,8 @@ <dd> <p> When there are more than this many packs that are not - marked with <tt>*.keep</tt> file in the repository, <tt>git gc - --auto</tt> consolidates them into one larger pack. The + marked with <code>*.keep</code> file in the repository, <code>git gc + --auto</code> consolidates them into one larger pack. The default value is 50. Setting this to 0 disables it. </p> </dd> @@ -3112,12 +3306,12 @@ </dt> <dd> <p> - Running <tt>git pack-refs</tt> in a repository renders it + Running <code>git pack-refs</code> in a repository renders it unclonable by Git versions prior to 1.5.1.2 over dumb transports such as HTTP. This variable determines whether - <em>git gc</em> runs <tt>git pack-refs</tt>. This can be set to <tt>notbare</tt> + <em>git gc</em> runs <code>git pack-refs</code>. This can be set to <code>notbare</code> to enable it within all non-bare repos or it can be set to a - boolean value. The default is <tt>true</tt>. + boolean value. The default is <code>true</code>. </p> </dd> <dt class="hdlist1"> @@ -3247,7 +3441,7 @@ derived from the git repository. The exact meaning depends on the used database driver, for SQLite (which is the default driver) this is a filename. Supports variable substitution (see - <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<tt>;</tt>). + <a href="git-cvsserver.html">git-cvsserver(1)</a> for details). May not contain semicolons (<code>;</code>). Default: <em>%Ggitcvs.%m.sqlite</em> </p> </dd> @@ -3260,7 +3454,7 @@ for this here, but it might not work. git-cvsserver is tested with <em>DBD::SQLite</em>, reported to work with <em>DBD::Pg</em>, and reported <strong>not</strong> to work with <em>DBD::mysql</em>. Experimental feature. - May not contain double colons (<tt>:</tt>). Default: <em>SQLite</em>. + May not contain double colons (<code>:</code>). Default: <em>SQLite</em>. See <a href="git-cvsserver.html">git-cvsserver(1)</a>. </p> </dd> @@ -3471,7 +3665,7 @@ </dt> <dd> <p> - If true, <em>git gui blame</em> uses <tt>-C</tt> instead of <tt>-C -C</tt> for original + If true, <em>git gui blame</em> uses <code>-C</code> instead of <code>-C -C</code> for original location detection. It makes blame significantly faster on huge repositories at the expense of less thorough copy detection. </p> @@ -3492,8 +3686,8 @@ <dd> <p> Specifies the radius of history context in days to show in - <a href="gitk.html">gitk(1)</a> for the selected commit, when the <tt>Show History - Context</tt> menu item is invoked from <em>git gui blame</em>. If this + <a href="gitk.html">gitk(1)</a> for the selected commit, when the <code>Show History + Context</code> menu item is invoked from <em>git gui blame</em>. If this variable is set to zero, the whole history is shown. </p> </dd> @@ -3503,7 +3697,7 @@ <dd> <p> Specifies the shell command line to execute when the corresponding item - of the <a href="git-gui.html">git-gui(1)</a> <tt>Tools</tt> menu is invoked. This option is + of the <a href="git-gui.html">git-gui(1)</a> <code>Tools</code> menu is invoked. This option is mandatory for every tool. The command is executed from the root of the working directory, and in the environment it receives the name of the tool as <em>GIT_GUITOOL</em>, the name of the currently selected file as @@ -3638,7 +3832,7 @@ <p> Override the HTTP proxy, normally configured using the <em>http_proxy</em>, <em>https_proxy</em>, and <em>all_proxy</em> environment variables (see - <tt>curl(1)</tt>). This can be overridden on a per-remote basis; see + <code>curl(1)</code>). This can be overridden on a per-remote basis; see remote.<name>.proxy </p> </dd> @@ -3877,7 +4071,7 @@ <p> In interactive commands, allow the user to provide one-letter input with a single key (i.e., without hitting enter). - Currently this is used by the <tt>--patch</tt> mode of + Currently this is used by the <code>--patch</code> mode of <a href="git-add.html">git-add(1)</a>, <a href="git-checkout.html">git-checkout(1)</a>, <a href="git-commit.html">git-commit(1)</a>, <a href="git-reset.html">git-reset(1)</a>, and <a href="git-stash.html">git-stash(1)</a>. Note that this setting is silently ignored if portable keystroke input @@ -3890,8 +4084,8 @@ <dd> <p> If true, makes <a href="git-log.html">git-log(1)</a>, <a href="git-show.html">git-show(1)</a>, and - <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <tt>--abbrev-commit</tt>. You may - override this option with <tt>--no-abbrev-commit</tt>. + <a href="git-whatchanged.html">git-whatchanged(1)</a> assume <code>--abbrev-commit</code>. You may + override this option with <code>--no-abbrev-commit</code>. </p> </dd> <dt class="hdlist1"> @@ -3901,8 +4095,8 @@ <p> Set the default date-time mode for the <em>log</em> command. Setting a value for log.date is similar to using <em>git log</em>'s - <tt>--date</tt> option. Possible values are <tt>relative</tt>, <tt>local</tt>, - <tt>default</tt>, <tt>iso</tt>, <tt>rfc</tt>, and <tt>short</tt>; see <a href="git-log.html">git-log(1)</a> + <code>--date</code> option. Possible values are <code>relative</code>, <code>local</code>, + <code>default</code>, <code>iso</code>, <code>rfc</code>, and <code>short</code>; see <a href="git-log.html">git-log(1)</a> for details. </p> </dd> @@ -3977,10 +4171,10 @@ <p> Specify the style in which conflicted hunks are written out to working tree files upon merge. The default is "merge", which - shows a <tt><<<<<<<</tt> conflict marker, changes made by one side, - a <tt>=======</tt> marker, changes made by the other side, and then - a <tt>>>>>>>></tt> marker. An alternate style, "diff3", adds a <tt>|||||||</tt> - marker and the original text before the <tt>=======</tt> marker. + shows a <code><<<<<<<</code> conflict marker, changes made by one side, + a <code>=======</code> marker, changes made by the other side, and then + a <code>>>>>>>></code> marker. An alternate style, "diff3", adds a <code>|||||||</code> + marker and the original text before the <code>=======</code> marker. </p> </dd> <dt class="hdlist1"> @@ -3991,9 +4185,9 @@ If merge is called without any commit argument, merge the upstream branches configured for the current branch by using their last observed values stored in their remote-tracking branches. - The values of the <tt>branch.<current branch>.merge</tt> that name the - branches at the remote named by <tt>branch.<current branch>.remote</tt> - are consulted, and then they are mapped via <tt>remote.<remote>.fetch</tt> + The values of the <code>branch.<current branch>.merge</code> that name the + branches at the remote named by <code>branch.<current branch>.remote</code> + are consulted, and then they are mapped via <code>remote.<remote>.fetch</code> to their corresponding remote-tracking branches, and the tips of these tracking branches are merged. </p> @@ -4005,11 +4199,11 @@ <p> By default, git does not create an extra merge commit when merging a commit that is a descendant of the current commit. Instead, the - tip of the current branch is fast-forwarded. When set to <tt>false</tt>, + tip of the current branch is fast-forwarded. When set to <code>false</code>, this variable tells git to create an extra merge commit in such - a case (equivalent to giving the <tt>--no-ff</tt> option from the command - line). When set to <tt>only</tt>, only such fast-forward merges are - allowed (equivalent to giving the <tt>--ff-only</tt> option from the + a case (equivalent to giving the <code>--no-ff</code> option from the command + line). When set to <code>only</code>, only such fast-forward merges are + allowed (equivalent to giving the <code>--ff-only</code> option from the command line). </p> </dd> @@ -4156,9 +4350,9 @@ <dd> <p> After performing a merge, the original file with conflict markers - can be saved as a file with a <tt>.orig</tt> extension. If this variable - is set to <tt>false</tt> then this file is not preserved. Defaults to - <tt>true</tt> (i.e. keep the backup files). + can be saved as a file with a <code>.orig</code> extension. If this variable + is set to <code>false</code> then this file is not preserved. Defaults to + <code>true</code> (i.e. keep the backup files). </p> </dd> <dt class="hdlist1"> @@ -4168,9 +4362,9 @@ <p> When invoking a custom merge tool, git uses a set of temporary files to pass to the tool. If the tool returns an error and this - variable is set to <tt>true</tt>, then these temporary files will be + variable is set to <code>true</code>, then these temporary files will be preserved, otherwise they will be removed after the tool has - exited. Defaults to <tt>false</tt>. + exited. Defaults to <code>false</code>. </p> </dd> <dt class="hdlist1"> @@ -4194,7 +4388,7 @@ exist, but a glob that does not match any refs is silently ignored. </p> -<div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_DISPLAY_REF</tt> +<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code> environment variable, which must be a colon separated list of refs or globs.</p></div> <div class="paragraph"><p>The effective value of "core.notesRef" (possibly overridden by @@ -4206,10 +4400,10 @@ </dt> <dd> <p> - When rewriting commits with <command> (currently <tt>amend</tt> or - <tt>rebase</tt>) and this variable is set to <tt>true</tt>, git + When rewriting commits with <command> (currently <code>amend</code> or + <code>rebase</code>) and this variable is set to <code>true</code>, git automatically copies your notes from the original to the - rewritten commit. Defaults to <tt>true</tt>, but see + rewritten commit. Defaults to <code>true</code>, but see "notes.rewriteRef" below. </p> </dd> @@ -4221,10 +4415,10 @@ When copying notes during a rewrite (see the "notes.rewrite.<command>" option), determines what to do if the target commit already has a note. Must be one of - <tt>overwrite</tt>, <tt>concatenate</tt>, or <tt>ignore</tt>. Defaults to - <tt>concatenate</tt>. + <code>overwrite</code>, <code>concatenate</code>, or <code>ignore</code>. Defaults to + <code>concatenate</code>. </p> -<div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_MODE</tt> +<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code> environment variable.</p></div> </dd> <dt class="hdlist1"> @@ -4238,9 +4432,9 @@ You may also specify this configuration several times. </p> <div class="paragraph"><p>Does not have a default value; you must configure this variable to -enable note rewriting. Set it to <tt>refs/notes/commits</tt> to enable +enable note rewriting. Set it to <code>refs/notes/commits</code> to enable rewriting for the default commit notes.</p></div> -<div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_REF</tt> +<div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable, which must be a colon separated list of refs or globs.</p></div> </dd> @@ -4345,13 +4539,13 @@ and this config option ignored whenever the corresponding pack is larger than 2 GB. </p> -<div class="paragraph"><p>If you have an old git that does not understand the version 2 <tt>*.idx</tt> file, +<div class="paragraph"><p>If you have an old git that does not understand the version 2 <code>*.idx</code> file, cloning or fetching over a non native protocol (e.g. "http" and "rsync") -that will copy both <tt>*.pack</tt> file and corresponding <tt>*.idx</tt> file from the +that will copy both <code>*.pack</code> file and corresponding <code>*.idx</code> file from the other side may give you a repository that cannot be accessed with your -older version of git. If the <tt>*.pack</tt> file is smaller than 2 GB, however, +older version of git. If the <code>*.pack</code> file is smaller than 2 GB, however, you can use <a href="git-index-pack.html">git-index-pack(1)</a> on the *.pack file to regenerate -the <tt>*.idx</tt> file.</p></div> +the <code>*.idx</code> file.</p></div> </dd> <dt class="hdlist1"> pack.packSizeLimit @@ -4360,7 +4554,7 @@ <p> The maximum size of a pack. This setting only affects packing to a file when repacking, i.e. the git:// protocol - is unaffected. It can be overridden by the <tt>--max-pack-size</tt> + is unaffected. It can be overridden by the <code>--max-pack-size</code> option of <a href="git-repack.html">git-repack(1)</a>. The minimum size allowed is limited to 1 MiB. The default is unlimited. Common unit suffixes of <em>k</em>, <em>m</em>, or <em>g</em> are @@ -4375,10 +4569,10 @@ If the value is boolean, turns on or off pagination of the output of a particular git subcommand when writing to a tty. Otherwise, turns on pagination for the subcommand using the - pager specified by the value of <tt>pager.<cmd></tt>. If <tt>--paginate</tt> - or <tt>--no-pager</tt> is specified on the command line, it takes + pager specified by the value of <code>pager.<cmd></code>. If <code>--paginate</code> + or <code>--no-pager</code> is specified on the command line, it takes precedence over this option. To disable pagination for all - commands, set <tt>core.pager</tt> or <tt>GIT_PAGER</tt> to <tt>cat</tt>. + commands, set <code>core.pager</code> or <code>GIT_PAGER</code> to <code>cat</code>. </p> </dd> <dt class="hdlist1"> @@ -4389,9 +4583,9 @@ Alias for a --pretty= format string, as specified in <a href="git-log.html">git-log(1)</a>. Any aliases defined here can be used just as the built-in pretty formats could. For example, - running <tt>git config pretty.changelog "format:* %H %s"</tt> - would cause the invocation <tt>git log --pretty=changelog</tt> - to be equivalent to running <tt>git log "--pretty=format:* %H %s"</tt>. + running <code>git config pretty.changelog "format:* %H %s"</code> + would cause the invocation <code>git log --pretty=changelog</code> + to be equivalent to running <code>git log "--pretty=format:* %H %s"</code>. Note that an alias with the same name as a built-in format will be silently ignored. </p> @@ -4437,15 +4631,17 @@ no refspec is implied by any of the options given on the command line. Possible values are: </p> +<div class="openblock"> +<div class="content"> <div class="ulist"><ul> <li> <p> -<tt>nothing</tt> - do not push anything. +<code>nothing</code> - do not push anything. </p> </li> <li> <p> -<tt>matching</tt> - push all branches having the same name in both ends. +<code>matching</code> - push all branches having the same name in both ends. This is for those who prepare all the branches into a publishable shape and then push them out with a single command. It is not appropriate for pushing into a repository shared by multiple users, @@ -4453,20 +4649,20 @@ if other users updated the branch. <br /> This is currently the default, but Git 2.0 will change the default - to <tt>simple</tt>. + to <code>simple</code>. </p> </li> <li> <p> -<tt>upstream</tt> - push the current branch to its upstream branch. - With this, <tt>git push</tt> will update the same remote ref as the one which - is merged by <tt>git pull</tt>, making <tt>push</tt> and <tt>pull</tt> symmetrical. +<code>upstream</code> - push the current branch to its upstream branch. + With this, <code>git push</code> will update the same remote ref as the one which + is merged by <code>git pull</code>, making <code>push</code> and <code>pull</code> symmetrical. See "branch.<name>.merge" for how to configure the upstream branch. </p> </li> <li> <p> -<tt>simple</tt> - like <tt>upstream</tt>, but refuses to push if the upstream +<code>simple</code> - like <code>upstream</code>, but refuses to push if the upstream branch’s name is different from the local one. This is the safest option and is well-suited for beginners. It will become the default in Git 2.0. @@ -4474,11 +4670,12 @@ </li> <li> <p> -<tt>current</tt> - push the current branch to a branch of the same name. +<code>current</code> - push the current branch to a branch of the same name. </p> </li> </ul></div> -<div class="paragraph"><p>The <tt>simple</tt>, <tt>current</tt> and <tt>upstream</tt> modes are for those who want to +</div></div> +<div class="paragraph"><p>The <code>simple</code>, <code>current</code> and <code>upstream</code> modes are for those who want to push out a single branch after finishing work, even when the other branches are not yet ready to be pushed out. If you are working with other people to push into the same shared repository, you would want @@ -4519,7 +4716,7 @@ If it is set to true, git-receive-pack will check all received objects. It will abort in the case of a malformed object or a broken link. The result of an abort are only dangling objects. - Defaults to false. If not set, the value of <tt>transfer.fsckObjects</tt> + Defaults to false. If not set, the value of <code>transfer.fsckObjects</code> is used instead. </p> </dd> @@ -4535,7 +4732,7 @@ a pack, after adding any missing delta bases. Storing the pack from a push can make the push operation complete faster, especially on slow filesystems. If not set, the value of - <tt>transfer.unpackLimit</tt> is used instead. + <code>transfer.unpackLimit</code> is used instead. </p> </dd> <dt class="hdlist1"> @@ -4641,7 +4838,7 @@ <dd> <p> If true, pushing to this remote will automatically behave - as if the <tt>--mirror</tt> option was given on the command line. + as if the <code>--mirror</code> option was given on the command line. </p> </dd> <dt class="hdlist1"> @@ -4650,7 +4847,7 @@ <dd> <p> If true, this remote will be skipped by default when updating - using <a href="git-fetch.html">git-fetch(1)</a> or the <tt>update</tt> subcommand of + using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of <a href="git-remote.html">git-remote(1)</a>. </p> </dd> @@ -4660,7 +4857,7 @@ <dd> <p> If true, this remote will be skipped by default when updating - using <a href="git-fetch.html">git-fetch(1)</a> or the <tt>update</tt> subcommand of + using <a href="git-fetch.html">git-fetch(1)</a> or the <code>update</code> subcommand of <a href="git-remote.html">git-remote(1)</a>. </p> </dd> @@ -4731,7 +4928,7 @@ </dt> <dd> <p> - When set to true, <tt>git-rerere</tt> updates the index with the + When set to true, <code>git-rerere</code> updates the index with the resulting contents after it cleanly resolves conflicts using previously recorded resolution. Defaults to false. </p> @@ -4744,8 +4941,8 @@ Activate recording of resolved conflicts, so that identical conflict hunks can be resolved automatically, should they be encountered again. By default, <a href="git-rerere.html">git-rerere(1)</a> is - enabled if there is an <tt>rr-cache</tt> directory under the - <tt>$GIT_DIR</tt>, e.g. if "rerere" was previously used in the + enabled if there is an <code>rr-cache</code> directory under the + <code>$GIT_DIR</code>, e.g. if "rerere" was previously used in the repository. </p> </dd> @@ -4882,7 +5079,7 @@ <dd> <p> By default, <a href="git-status.html">git-status(1)</a> shows paths relative to the - current directory. Setting this variable to <tt>false</tt> shows paths + current directory. Setting this variable to <code>false</code> shows paths relative to the repository root (this was the default for git prior to v1.5.4). </p> @@ -4900,23 +5097,26 @@ systems. So, this variable controls how the commands displays the untracked files. Possible values are: </p> +<div class="openblock"> +<div class="content"> <div class="ulist"><ul> <li> <p> -<tt>no</tt> - Show no untracked files. +<code>no</code> - Show no untracked files. </p> </li> <li> <p> -<tt>normal</tt> - Show untracked files and directories. +<code>normal</code> - Show untracked files and directories. </p> </li> <li> <p> -<tt>all</tt> - Show also individual files in untracked directories. +<code>all</code> - Show also individual files in untracked directories. </p> </li> </ul></div> +</div></div> <div class="paragraph"><p>If this variable is not specified, it defaults to <em>normal</em>. This variable can be overridden with the -u|--untracked-files option of <a href="git-status.html">git-status(1)</a> and <a href="git-commit.html">git-commit(1)</a>.</p></div> @@ -4947,7 +5147,7 @@ The path within this project, URL, and the updating strategy for a submodule. These variables are initially populated by <em>git submodule init</em>; edit them to override the - URL and other values found in the <tt>.gitmodules</tt> file. See + URL and other values found in the <code>.gitmodules</code> file. See <a href="git-submodule.html">git-submodule(1)</a> and <a href="gitmodules.html">gitmodules(5)</a> for details. </p> </dd> @@ -4998,7 +5198,7 @@ </dt> <dd> <p> - When <tt>fetch.fsckObjects</tt> or <tt>receive.fsckObjects</tt> are + When <code>fetch.fsckObjects</code> or <code>receive.fsckObjects</code> are not set, the value of this variable is used instead. Defaults to false. </p> @@ -5008,7 +5208,7 @@ </dt> <dd> <p> - When <tt>fetch.unpackLimit</tt> or <tt>receive.unpackLimit</tt> are + When <code>fetch.unpackLimit</code> or <code>receive.unpackLimit</code> are not set, the value of this variable is used instead. The default value is 100. </p> @@ -5091,11 +5291,15 @@ </dd> </dl></div> </div> +</div> +</div> +<div class="sect1"> <h2 id="_git">GIT</h2> <div class="sectionbody"> <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> </div> </div> +</div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text">